home *** CD-ROM | disk | FTP | other *** search
/ Info-Mac 4 / Info_Mac IV CD-ROM (Pacific HiTech Inc.)(August 1994).iso / HyperCard / textNumber XFCN 1.0 / About textNumber XFCN 1.0 next >
Text File  |  1994-04-29  |  5KB  |  139 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6. About This Document
  7. -------------------
  8.  
  9. This document describes
  10. • what the textNumber XFCN is
  11. • how to install it
  12. • how to use the XFCN within HyperCard
  13.  
  14.  
  15. What does it do?
  16. ----------------
  17.  
  18. textNumber is a freeware HyperCard external function that turns numbers into full-length phrases. So, 43283 becomes “fourty-three thousand, two hundred and eighty-three.” textNumber can also handle fractions and divisions, so that it can change “1.42” into “one point four two” and  “2/3” into “two thirds.”
  19.  
  20. Installing the XFCN
  21. -------------------
  22.  
  23. To install textNumber, open the accompanying ResEdit 2.1 document and copy the XFCN resource into your source stack. If you would like to use textNumber in all your stacks, paste it into your Home stack. (If you do not own ResEdit, you can use the Resource Mover, in the Power Tools stack.)
  24.  
  25. 1. Open the file “textNumber XFCN 1.0” in ResEdit 2.1.
  26.  
  27. 2. Choose Select All from the Edit menu.
  28.  
  29. 3. Choose Copy from the Edit menu.
  30.  
  31. 4. Choose Open… from the File menu.
  32.   Select the stack to copy the XFCN into, then click Open.
  33.   If the stack does not contain any other resources, 
  34.   ResEdit will ask if you want to add a resource fork to the 
  35.   file. Click OK.
  36.  
  37. 5. Choose Paste from the Edit menu.
  38.  
  39. 6. Choose Save from the File menu.
  40.  
  41. 7. Choose Quit from the File menu.
  42.  
  43.  
  44. Using the textNumber XFCN
  45. -------------------------
  46.  
  47. The format for calling textNumber is:
  48.  
  49.     textNumber ( <number or string> [, <possessive>] [, <plural>] )
  50.  
  51. where:
  52.  
  53. <number or string> is a simple integer (such as “10”),  a decimal
  54.     number (such as “2.765347”), or a string (such as "-2/3").
  55. <possessive> is either true or false, and changes “three” 
  56.     to “third”, for instance.
  57. <plural> is either true or false, and simply adds an “s”
  58.  
  59. Both the <describe> and <plural> operators are optional. Passing "?" or "!" return on-line help or version information, respectively.
  60.  
  61.  
  62. Known Limitations
  63. -----------------
  64.  
  65. In version 1.0, 
  66.  
  67. • textNumber will correctly translate any number between 
  68.   -2,147,483,646 to 2,147,483,646. Numbers outside this 
  69.   range may produce unpredictable results.
  70.  
  71. • mathematical symbols other than “.” and “/” are not parsed.
  72.   Passing the string "12*5" as the number will return an error.
  73.  
  74. • passing 1/4 (NOT a string), as in:
  75.         textNumber (1/4)
  76.   will return “zero point two five,” but passing "1/4," as in:
  77.         textNumber ("1/4")
  78.   will return  “one quarter.”
  79.  
  80.  
  81. Licensing Information
  82. ---------------------
  83.  
  84. This software is FreeWare, but not in the Public Domain. You may use and distribute this software freely, so long as you distribute this document with it. You may distribute this XFCN in your stacks, providing that they are also freeware, and that you credit the author in your software or its documentation.
  85.     You may NOT distribute this software for shareware or commercial use without the author’s express permission.
  86.  
  87.  
  88. Disclaimer
  89. ----------
  90.  
  91. ALTHOUGH EVERY EFFORT HAS BEEN MADE TO MAKE THIS SOFTWARE RELIABLE AND STABLE, SIMON POISSON (THE SOFTWARE AUTHOR) MAKES NO WARRANTIES (EITHER EXPRESS OR IMPLIED) AS TO THE SUITABILITY OF THIS SOFTWARE FOR ANY PURPOSE. THE SOFTWARE AUTHOR ACCEPTS NO RESPONSIBILITY FOR ANY AND ALL DAMAGES INCURRED THROUGH THE USE (OR MISUSE) OF THIS SOFTWARE. (BOTTOM LINE: USE THIS SOFTWARE AT YOUR OWN RISK.)
  92.  
  93.  
  94. Reporting Bugs
  95. --------------
  96.  
  97. If you discover a situation where textNumber does not perform entirely to your satisfaction, or have ideas as to how it could be enhanced, please contact me as per below.
  98.  
  99.  
  100. By The Same Author
  101. ------------------
  102.  
  103. Script Optimizer 1.0.1
  104.     A HyperTalk optimizer with an easy-to-use, 
  105.     graphical interface. Abbreviates keywords,  
  106.     removes comments, and deletes unused globals.
  107. Myst Hints 1.0
  108.     View multiple clues (from subtle hints, to stronger 
  109.     'suggestions') to specific questions in 6 categories.
  110. TarotWorks 1.0 (June 1994)
  111.     A full-color, extendable Tarot card program for 
  112.     generating Tarot card readings on your computer 
  113.     or by hand, using a variety of layouts (or 'spreads').
  114. Icon Vault Package 1.0
  115.     Collection of 17 System 7 Finder icon vaults to add new 
  116.     colour icons to applications, extensions, and documents.
  117. Faster Finder 7.rsrc
  118.     A quick ResEdit hack to inhibit zoom rectangles, add a Quit 
  119.     command to the File menu, and add command keys for the 
  120.     Make Alias, Clean Up, and Empty Trash commands.
  121.  
  122.  
  123. Simon Poisson
  124. -------------
  125.  
  126. FirstClass E-Mail:
  127.     Simon Poisson,MacInTouch
  128.  
  129. Snail Mail:
  130.     PO Box 256
  131.     Darlinghurst  NSW
  132.     Australia  2010
  133.  
  134.  
  135. Thank you for reading this document.
  136.  
  137.  
  138.  
  139. Friday, 29 April 1994